home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 019a / zipup143.zip / ZIPUP143.DOC < prev   
Text File  |  1991-11-14  |  13KB  |  360 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                ZIPUP Version 1.43
  18.  
  19.               "ZIP Comment Stripper/Adder"
  20.  
  21.  
  22.                November 14, 1991
  23.  
  24.  
  25.  
  26.                   Written by:
  27.  
  28.                    Bob Jaques
  29.  
  30.                   and
  31.  
  32.                    Jim Barth
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40. PURPOSE/INTRODUCTION
  41. --------------------
  42.  
  43. "ZIPUP" is a handy utility written and compiled in Turbo C++ that will
  44. add comments to user-supplied files that are compressed under Phil Katz's
  45. PKZIP compression routines.  ZIPUP does not rely on the use of PKZIP.EXE
  46. since it has its own algorithms for inserting and modifying comments
  47. within the archive.  ZIPUP is flexible and configurable to fit the
  48. needs of most who would use this type of program.  This utility has been
  49. tested under all known possible combinations and has proven to be
  50. reliable, fast and easy-to-use, but we, the authors, can take no liability
  51. nor provide any guarantee for the use of this program.  If you come across
  52. a problem or a suggestion to make this routine better and more efficient,
  53. please drop us a line as we would like to hear your comments.  At any rate,
  54. please share this program with others.
  55.  
  56. The authors also wish to send a word of "thanks" to the many users who
  57. have tried and commented on the previous versions of ZIPUP -- your feedback
  58. encouraged this enhancement release and we are dedicated to make ZIPUP
  59. the friendliest and fastest .ZIP comment manager around.
  60.  
  61.  
  62.  
  63. COST
  64. ----
  65.  
  66. There is no cost!  There are already too many programs (even other .ZIP
  67. comment utilities) that can and will "nickle-and-dime" you to death.  This
  68. utility is not Shareware, commercial or public domain.  Instead, it is
  69. "PostWare", meaning that if you like it and find it useful, we would
  70. appreciate you sending us a postcard from your locale letting us know
  71. that you are using it.  Or, drop one or the other of the authors a FIDO-Net
  72. NETMAIL message letting us know your comments on the utility.
  73.  
  74.    Bob Jaques                              Jim Barth
  75.    297 County Road 1488                    11544 Kevin Lane NE
  76.    Cullman, AL  35055                      Poulsbo, WA  98370
  77.  
  78.    BBS: The Exchange of Bytes BBS          BBS: The Jimby! BBS 
  79.     Ph. 205-795-7005                        Ph. 206-698-1044
  80.     (12 - 9600 HST)                         (300 - 9600 HST/DS)
  81.                     
  82.    Fidonet Address - 1:3607/21.0           Fidonet Address - 1:350/21.0
  83.  
  84.  
  85.  
  86.  
  87. USAGE
  88. -----
  89.  
  90. Beginning with Version 1.40, ZIPUP will make use of a DOS environment
  91. variable "ZIPUP" if this option is used.  ZIPUP's speed is significantly
  92. increased by setting the variable to the path and filename of your .ZIP
  93. comment file.  The following are some examples of this option:
  94.  
  95. SET ZIPUP=C:\MISC\ZIPUP.TXT            => Sets your comment file name to
  96.                       ZIPUP.TXT, which is located in
  97.                       C:\MISC\
  98.  
  99. SET ZIPUP=D:\WILDCAT\NEWUPS\MYZIP.TXT  => Sets your comment file name to
  100.                       MYZIP.TXT, which is located in
  101.                       D:\WILDCAT\NEWUPS\
  102.  
  103. Note that if you opt to use the ZIPUP variable as just described,  you
  104. do not have to enter it again on the command line or have a ZIPUP.TXT
  105. file located in the working directory.  You can, however, override a
  106. preset named ZIP comment file by entering a different name on the
  107. command line as described below.  It should be further noted that the
  108. use of the "SET ZIPUP=..." command is purely optional.  Omitting this
  109. option will cause ZIPUP to simply act in the same manner as previous
  110. versions of ZIPUP.
  111.  
  112. ZIPUP will accept up to two command line arguments to process your ZIP
  113. files in the general format of:
  114.  
  115.            ZIPUP C:\PATH\ZIPFILE.ZIP C:\PATH\COMMENT.TXT
  116.  
  117. If no argument for the comment path\filename is entered, and if the
  118. option described above is not utilized, ZIPUP will automatically default
  119. to use a comment file called ZIPUP.TXT, which should be in the same
  120. directory that ZIPUP is run from.  The comment file is simply any ASCII
  121. or ANSI file that you create with your word processor or text editor
  122. (such as DOS' EDLIN.COM) and is often used to personalize a bulletin
  123. board's downloadable files.  There is an upper size limit to the length of
  124. the comment file that can be inserted to a ZIP file by ZIPUP, which is
  125. around 4,096 bytes.  (A comment file that is 4K long is a somewhat unfeasible
  126. in our opinion.)
  127.  
  128. If there are already comments attached to the ZIP files that ZIPUP will
  129. process, ZIPUP will automatically replace those "old" comments with the
  130. comment specified in your comment file.  This is a handy fix for users who
  131. upload ZIP files to a BBS that still has comments from the BBS he may have
  132. just downloaded it from.
  133.  
  134.  
  135. STRIPPING .ZIP COMMENTS ALLTOGETHER
  136. ----------------------------------
  137.  
  138. For those who want to get rid of comments placed in .ZIP files, ZIPUP is
  139. capable of doing this chore as well.  Since ZIPUP's main purpose is to
  140. insert or replace comments, the manner in which one would delete the
  141. comments is to actually insert a comment -- a comment of 0 bytes in
  142. length.  One way of doing this is to open a file for editing using an
  143. editor such as EDLIN.COM (or similair) and then closing that file.  For
  144. ease of use, you might want to consider naming that file ZIPUP.TXT.
  145. Then to strip a .ZIP file (or a whole directory of .ZIP files) follow
  146. the same procedure as presented in this documentation.  Presto!  Your
  147. 0-byte comment file will be inserted, eliminating any previous comments.
  148.  
  149.  
  150. EXAMPLES
  151. --------
  152.  
  153. Here are some valid examples for the use of ZIPUP:
  154. ZIPUP                                  => Program will prompt for .ZIP file 
  155.                       name.  If the comment file
  156.                       name is not found in the DOS
  157.                       environment table, a comment file
  158.                       name will also be prompted for.
  159.  
  160. ZIPUP *.*                              => Adds a comment to all .ZIP files
  161.                       in the current directory.
  162.                       (Note that the '.ZIP' file need
  163.                       not have an actual '.ZIP'
  164.                       extention -- ZIPUP can and
  165.                       will detect if it is a .ZIP
  166.                       file.)
  167.                       If the ZIPUP variable containing
  168.                       a pre-defined comment file
  169.                       name is found, that comment
  170.                       file will be added to all .ZIP
  171.                       files.  Otherwise, a default
  172.                       comment file of ZIPUP.TXT,
  173.                       located in the current
  174.                       directory will be used.
  175.  
  176. ZIPUP *.ZIP                            => Effectivly the same as the above
  177.                       example.  Will run slightly 
  178.                       faster as it doesn't have to check
  179.                       whether the file has a .ZIP
  180.                       extension.  
  181.  
  182. ZIPUP ZIPFILE.* COMMENT.TXT            => Adds the comment stored in
  183.                       COMMENT.TXT to the specific file
  184.                       ZIPFILE.ZIP.  Program will ignore
  185.                       anything but a .ZIP file 
  186.                       automatically.  By specifying
  187.                       a comment file to use, as in
  188.                       this example, a predefined
  189.                       comment file pointed to by the
  190.                       ZIPUP variable, will be
  191.                       overridden.
  192.  
  193. ZIPUP ZIPFILE.ZIP COMMENT.TXT          => Exact same results as above
  194.                       example.  Runs slightly faster as 
  195.                       it doesn't have to check whether
  196.                       the file has the .ZIP extension.
  197.                       This overrides a comment file
  198.                       name that was that was
  199.                       previously declared in the DOS
  200.                       environment.
  201.   
  202. ZIPUP E:\BBS\UPLOAD\*.ZIP C:\ZIPUP.TXT => Adds the comment stored in
  203.                       C:\ZIPUP.TXT to all ZIP files
  204.                       found in E:\BBS\UPLOAD\
  205.  
  206.  
  207. ERROR LEVELS
  208. ------------
  209.  
  210. Since ZIPUP was written to be easily run from a batch file, two possible
  211. ERRORLEVELS are set after the program has run.  If no errors were
  212. encountered during program execution, the ERRORLEVEL will be set to '0'.
  213. If, on the other hand, ZIPUP was unable to execute flawlessly, the returned
  214. ERRORLEVEL will be set to '1'.  After running this routine for a while, we
  215. have noticed that perhaps a couple more ERRORLEVELS would be handy to
  216. indicate specific "problems", this will be added in a future update.
  217.  
  218. SOURCE CODE
  219. -----------
  220.  
  221. This utility came about as a result of a combination of the authors
  222. wanting to know more about the structures used in Phil Katz's remarkable
  223. .ZIP files and wanting to write a useful utility incorporating this
  224. knowledge.  If you would like more information on the way this program
  225. processes a .ZIP file, please feel free to write or leave a message on
  226. either author's BBS systems.
  227.  
  228.  
  229. UPDATES
  230. -------
  231.  
  232. This pet project of the authors, ZIPUP, undergoes revision from time-to-time.
  233. The latest revision of ZIPUP can be obtained directly from the authors,
  234. who each run a BBS.  Using FIDONET, File Requesting the magic name of
  235. 'ZIPUP' will result in obtaining the latest version.  The latest
  236. version ZIPUP is also downloadable from either author's BBS.
  237.  
  238.  
  239. VALIDATION
  240. ----------
  241.  
  242. For those who wish to validate the current copy of ZIPUP.EXE, the
  243. following was reported by McAffee Associates' VALIDATE.COM utility:
  244.  
  245.       File Name:  ZIPUP.EXE
  246.            Size:  13,964
  247.            Date:  11-14-1991
  248.            
  249. File Authentication:
  250.      Check Method 1 - 0643
  251.      Check Method 2 - 05B0
  252.  
  253.  
  254.  
  255. HISTORY
  256. -------
  257. Version 1.43
  258.    
  259.    Corrected a bug that showed up when a person was processing multiple 
  260.    files.  If you tried to fix the comment 15 consecutive non-ZIP files,
  261.    the program would not recognize ANY zip files.  
  262.     
  263.    Changed the routine that actually writes the comment to the ZIP archive,
  264.    to make it a bit faster.
  265.  
  266. Version 1.42
  267.  
  268.    Increased ZIPUP's execution speed by approximately 150% by reading
  269.    the .ZIP Comment File into memory and then writing out of memory when
  270.    processing the individual .ZIP files.  This increase is most notable
  271.    when processing several .ZIP files from the command line using
  272.    wildcards, but is noticeable when processing even single files.  In
  273.    previous versions, the .ZIP Comment File was opened and read for EACH
  274.    of the .ZIP files ZIPUP processed -- a process we knew was slowing
  275.    ZIPUP down but we were too lazy to correct.
  276.  
  277.    Corrected a bug that didn't restore the original TIMESTAMP to the
  278.    files that ZIPUP was processing.  In version 1.30, the problem of
  279.    restoring the original file datestamp was resolved, but the timestamp
  280.    was overlooked.
  281.  
  282.    Added an information line to the output screen that showed the user
  283.    what .ZIP comment file was being inserted into the archives, as well
  284.    as the length that file.
  285.  
  286.    Expounded the documentation.
  287.  
  288. Version 1.41ß  (Not released to the public)
  289.    
  290.    Changed how ZIPUP determines whether the file is a ZIP compressed file
  291.    or not.  Now the program looks at the starting header of the file and
  292.    ignores the extension.  It makes it so you can add a comment to a ZIP
  293.    file that does not end with a .ZIP extension.  In addition, this also
  294.    speeds up the execution on Wildcard type comment changes.
  295.     
  296.    Changed code so that it will only search 0xFFFF bytes into the archive.  
  297.    That is the physical size limit of any zip comment.
  298.  
  299.  
  300. Version 1.40
  301.  
  302.    Tightened up the code, causing the executable file to be smaller yet
  303.    run significantly faster.
  304.  
  305.    Cleaned up the source code some for easier readiblity by those who
  306.    wish to peruse it.
  307.  
  308.    Invoked a 4,096 byte limit to the allowable length of a .ZIP comment
  309.    file.
  310.  
  311.    Added the ability to use the DOS environment to pre-define the
  312.    location of the .ZIP comment file.  This also increased the execution
  313.    speed somewhat, as well as making the program easier to use.
  314.  
  315.  
  316. Version 1.30
  317.    
  318.    Added code to prompt for .ZIP file name and Comment file name if they
  319.    aren't found on the command line. Some late releases of Version 1.2
  320.    had this feature.
  321.  
  322.    Added some code to retain the original date of the .ZIP file.  This was
  323.    requested by some of the users who don't get a chance to process the 
  324.    uploads on there BBS the same day they get them.
  325.  
  326.    Sped up the display of the working indicator to show activity better 
  327.    when ZIPUP is used on a network.
  328.    
  329.  
  330. Version 1.20
  331.  
  332.    Improved the command line use of Wildcards. All DOS wildcards are now
  333.    supported.
  334.  
  335.    Added error messages for non-fatal errors.
  336.  
  337.    Changed display to look similar to PKZIP.
  338.  
  339.    Added indicator to tell when program is actually working. (Thanks, Phil!)
  340.  
  341.  
  342. Version 1.10
  343.     
  344.    Fixed major bug that cropped up when you tried to add a shorter comment 
  345.    to the ZIP file than what was there before.  The program used to just
  346.    skip over the offending .ZIP file and go on to the next one.
  347.  
  348.    Introduced limited wildcard usage.
  349.  
  350.    Fixed minor bugs that were reported in Version 1.0.
  351.  
  352.    Modified display of program to show file that have been processed.
  353.  
  354.  
  355. Version 1.00  10-15-89
  356.     
  357.    The first release. 
  358.  
  359.  
  360.